Change in openvpn[master]: Fix new doxygen warnings about using @return in void functions
A message that is not in the archive (sent off-list or not yet received): gerrit.1747748031000.Ia2b3eda18bd6dbce6c470037c7a01097e8147c29@...2715...
Attention is currently required from: plaisthos.
Hello plaisthos,
I'd like you to do a code review.
Please visit
http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email
to review the following change.
Change subject: Fix new doxygen warnings about using @return in void functions
......................................................................
Fix new doxygen warnings about using @return in void functions
These seem to have been added in a more recent doxygen version than I previously tested with.
---
M src/openvpn/crypto.h
M src/openvpn/fragment.h
M src/openvpn/push.c
3 files changed, 10 insertions(+), 8 deletions(-)
git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/29/1029/1
src/openvpn/crypto.h +2 -2
@@ -467,12 +467,12 @@* If an error occurs during processing, then the \a buf %buffer is set to * empty. * -* @param buf - The %buffer containing the packet on which to +* @param[in,out] buf - The %buffer containing the packet on which to * perform security operations. * @param work - An initialized working %buffer. * @param opt - The security parameter state for this VPN tunnel. * -* @return This function returns void.\n On return, the \a buf argument +* @note This function returns void.\n On return, the \a buf argument * will point to the resulting %buffer. This %buffer will either * contain the processed packet ready for sending, or be empty if an * error occurred.
src/openvpn/fragment.h +8 -4
@@ -309,7 +309,7 @@* * @param f - The \c fragment_master structure for this VPN * tunnel. -* @param buf - A pointer to the buffer structure containing the +* @param[in,out] buf - A pointer to the buffer structure containing the * incoming packet. This pointer will have been * modified on return either to point to a * completely reassembled packet, or to have length
@@ -317,7 +317,9 @@* @param frame - The packet geometry parameters for this VPN * tunnel. * -* @return Void.\n On return, the \a buf argument will point to a buffer. +* @note Does not have a return value.\n +* However, on return, the \a buf argument buffer will be modified +* to communicate the result of the function. * The buffer will have nonzero length if the incoming packet passed * to this function was whole and unfragmented, or if it was the final * part of a fragmented packet thereby completing reassembly. On the
@@ -363,14 +365,16 @@* * @param f - The \c fragment_master structure for this VPN * tunnel. -* @param buf - A pointer to the buffer structure containing the +* @param[in,out] buf - A pointer to the buffer structure containing the * outgoing packet. This pointer will be modified * to point to a whole unfragmented packet or to the * first part of a fragmented packet on return. * @param frame - The packet geometry parameters for this VPN * tunnel. * -* @return Void.\n On return, the \a buf argument will point to a buffer. +* @note Does not have a return value.\n +* However, on return, the \a buf argument buffer will be modified +* to communicate the result of the function. * This buffer contains either the whole original outgoing packet if * fragmentation was not necessary, or the first part of the * fragmented outgoing packet if fragmentation was necessary. In both
src/openvpn/push.c +0 -2
@@ -582,8 +582,6 @@* @param tls_multi tls multi context of VPN tunnel * @param gc gc arena for allocating push options * @param push_list push list to where options are added -* -* @return true on success, false on failure. */ void prepare_auth_token_push_reply(struct tls_multi *tls_multi, struct gc_arena *gc,
--
To view, visit http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email
To unsubscribe, or for help writing mail filters, visit http://gerrit.openvpn.net/settings
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Ia2b3eda18bd6dbce6c470037c7a01097e8147c29
Gerrit-Change-Number: 1029
Gerrit-PatchSet: 1
Gerrit-Owner: flichtenheld <[email protected]...>
Gerrit-Reviewer: plaisthos <[email protected]...>
Gerrit-CC: openvpn-devel <[email protected]>
Gerrit-Attention: plaisthos <[email protected]...>
Gerrit-MessageType: newchange
Attention is currently required from: flichtenheld.
plaisthos has posted comments on this change. ( http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email )
Change subject: Fix new doxygen warnings about using @return in void functions
......................................................................
Patch Set 1: Code-Review+2
--
To view, visit http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email
To unsubscribe, or for help writing mail filters, visit http://gerrit.openvpn.net/settings
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Ia2b3eda18bd6dbce6c470037c7a01097e8147c29
Gerrit-Change-Number: 1029
Gerrit-PatchSet: 1
Gerrit-Owner: flichtenheld <[email protected]...>
Gerrit-Reviewer: plaisthos <[email protected]...>
Gerrit-CC: openvpn-devel <[email protected]>
Gerrit-Attention: flichtenheld <[email protected]...>
Gerrit-Comment-Date: Wed, 02 Jul 2025 12:16:25 +0000
Gerrit-HasComments: No
Gerrit-Has-Labels: Yes
Gerrit-MessageType: comment
Attention is currently required from: flichtenheld.
ordex has posted comments on this change. ( http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email )
Change subject: Fix new doxygen warnings about using @return in void functions
......................................................................
Patch Set 1: Code-Review-1
(1 comment)
Patchset:
PS1:
can we drop the part saying "Does not have a return value." ?
We are not documenting @return anymore and functions are void. so it's pretty redundant
--
To view, visit http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email
To unsubscribe, or for help writing mail filters, visit http://gerrit.openvpn.net/settings
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Ia2b3eda18bd6dbce6c470037c7a01097e8147c29
Gerrit-Change-Number: 1029
Gerrit-PatchSet: 1
Gerrit-Owner: flichtenheld <[email protected]...>
Gerrit-Reviewer: ordex <[email protected]...>
Gerrit-Reviewer: plaisthos <[email protected]...>
Gerrit-CC: openvpn-devel <[email protected]>
Gerrit-Attention: flichtenheld <[email protected]...>
Gerrit-Comment-Date: Wed, 02 Jul 2025 12:21:36 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: Yes
Gerrit-MessageType: comment
Attention is currently required from: flichtenheld, ordex, plaisthos.
Hello ordex, plaisthos,
I'd like you to reexamine a change. Please visit
http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email
to look at the new patch set (#2).
The following approvals got outdated and were removed:
Code-Review+2 by plaisthos, Code-Review-1 by ordex
The change is no longer submittable: Code-Review and checks~ChecksSubmitRule are unsatisfied now.
Change subject: Fix new doxygen warnings about using @return in void functions
......................................................................
Fix new doxygen warnings about using @return in void functions
These seem to have been added in a more recent doxygen version than I previously tested with.
---
M src/openvpn/crypto.h
M src/openvpn/fragment.h
M src/openvpn/push.c
3 files changed, 8 insertions(+), 8 deletions(-)
git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/29/1029/2
src/openvpn/crypto.h +2 -2
@@ -467,12 +467,12 @@* If an error occurs during processing, then the \a buf %buffer is set to * empty. * -* @param buf - The %buffer containing the packet on which to +* @param[in,out] buf - The %buffer containing the packet on which to * perform security operations. * @param work - An initialized working %buffer. * @param opt - The security parameter state for this VPN tunnel. * -* @return This function returns void.\n On return, the \a buf argument +* @note On return, the \a buf argument * will point to the resulting %buffer. This %buffer will either * contain the processed packet ready for sending, or be empty if an * error occurred.
src/openvpn/fragment.h +6 -4
@@ -309,7 +309,7 @@* * @param f - The \c fragment_master structure for this VPN * tunnel. -* @param buf - A pointer to the buffer structure containing the +* @param[in,out] buf - A pointer to the buffer structure containing the * incoming packet. This pointer will have been * modified on return either to point to a * completely reassembled packet, or to have length
@@ -317,7 +317,8 @@* @param frame - The packet geometry parameters for this VPN * tunnel. * -* @return Void.\n On return, the \a buf argument will point to a buffer. +* @note On return the \a buf argument buffer will be modified +* to communicate the result of the function. * The buffer will have nonzero length if the incoming packet passed * to this function was whole and unfragmented, or if it was the final * part of a fragmented packet thereby completing reassembly. On the
@@ -363,14 +364,15 @@* * @param f - The \c fragment_master structure for this VPN * tunnel. -* @param buf - A pointer to the buffer structure containing the +* @param[in,out] buf - A pointer to the buffer structure containing the * outgoing packet. This pointer will be modified * to point to a whole unfragmented packet or to the * first part of a fragmented packet on return. * @param frame - The packet geometry parameters for this VPN * tunnel. * -* @return Void.\n On return, the \a buf argument will point to a buffer. +* @note On return the \a buf argument buffer will be modified +* to communicate the result of the function. * This buffer contains either the whole original outgoing packet if * fragmentation was not necessary, or the first part of the * fragmented outgoing packet if fragmentation was necessary. In both
src/openvpn/push.c +0 -2
@@ -582,8 +582,6 @@* @param tls_multi tls multi context of VPN tunnel * @param gc gc arena for allocating push options * @param push_list push list to where options are added -* -* @return true on success, false on failure. */ void prepare_auth_token_push_reply(struct tls_multi *tls_multi, struct gc_arena *gc,
--
To view, visit http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email
To unsubscribe, or for help writing mail filters, visit http://gerrit.openvpn.net/settings
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Ia2b3eda18bd6dbce6c470037c7a01097e8147c29
Gerrit-Change-Number: 1029
Gerrit-PatchSet: 2
Gerrit-Owner: flichtenheld <[email protected]...>
Gerrit-Reviewer: ordex <[email protected]...>
Gerrit-Reviewer: plaisthos <[email protected]...>
Gerrit-CC: openvpn-devel <[email protected]>
Gerrit-Attention: plaisthos <[email protected]...>
Gerrit-Attention: flichtenheld <[email protected]...>
Gerrit-Attention: ordex <[email protected]...>
Gerrit-MessageType: newpatchset
Attention is currently required from: flichtenheld, plaisthos.
ordex has posted comments on this change. ( http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email )
Change subject: Fix new doxygen warnings about using @return in void functions
......................................................................
Patch Set 2: Code-Review+2
--
To view, visit http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email
To unsubscribe, or for help writing mail filters, visit http://gerrit.openvpn.net/settings
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Ia2b3eda18bd6dbce6c470037c7a01097e8147c29
Gerrit-Change-Number: 1029
Gerrit-PatchSet: 2
Gerrit-Owner: flichtenheld <[email protected]...>
Gerrit-Reviewer: ordex <[email protected]...>
Gerrit-Reviewer: plaisthos <[email protected]...>
Gerrit-CC: openvpn-devel <[email protected]>
Gerrit-Attention: plaisthos <[email protected]...>
Gerrit-Attention: flichtenheld <[email protected]...>
Gerrit-Comment-Date: Wed, 02 Jul 2025 14:31:03 +0000
Gerrit-HasComments: No
Gerrit-Has-Labels: Yes
Gerrit-MessageType: comment
PATCH v2 1/1 Fix new doxygen warnings about using @return in void functions
In reply to a message not in the archiveFrom: Frank Lichtenheld <[email protected]...>
These seem to have been added in a more recent doxygen version than I previously tested with.
---
This change was reviewed on Gerrit and approved by at least one developer. I request to merge it to master.
Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1029
This mail reflects revision 2 of this Change.
Acked-by according to Gerrit (reflected above):
Antonio Quartulli <[email protected]...>
src/openvpn/crypto.h +2 -2
@@ -467,12 +467,12 @@* If an error occurs during processing, then the \a buf %buffer is set to * empty. * -* @param buf - The %buffer containing the packet on which to +* @param[in,out] buf - The %buffer containing the packet on which to * perform security operations. * @param work - An initialized working %buffer. * @param opt - The security parameter state for this VPN tunnel. * -* @return This function returns void.\n On return, the \a buf argument +* @note On return, the \a buf argument * will point to the resulting %buffer. This %buffer will either * contain the processed packet ready for sending, or be empty if an * error occurred.
src/openvpn/fragment.h +6 -4
@@ -309,7 +309,7 @@* * @param f - The \c fragment_master structure for this VPN * tunnel. -* @param buf - A pointer to the buffer structure containing the +* @param[in,out] buf - A pointer to the buffer structure containing the * incoming packet. This pointer will have been * modified on return either to point to a * completely reassembled packet, or to have length
@@ -317,7 +317,8 @@* @param frame - The packet geometry parameters for this VPN * tunnel. * -* @return Void.\n On return, the \a buf argument will point to a buffer. +* @note On return the \a buf argument buffer will be modified +* to communicate the result of the function. * The buffer will have nonzero length if the incoming packet passed * to this function was whole and unfragmented, or if it was the final * part of a fragmented packet thereby completing reassembly. On the
@@ -363,14 +364,15 @@* * @param f - The \c fragment_master structure for this VPN * tunnel. -* @param buf - A pointer to the buffer structure containing the +* @param[in,out] buf - A pointer to the buffer structure containing the * outgoing packet. This pointer will be modified * to point to a whole unfragmented packet or to the * first part of a fragmented packet on return. * @param frame - The packet geometry parameters for this VPN * tunnel. * -* @return Void.\n On return, the \a buf argument will point to a buffer. +* @note On return the \a buf argument buffer will be modified +* to communicate the result of the function. * This buffer contains either the whole original outgoing packet if * fragmentation was not necessary, or the first part of the * fragmented outgoing packet if fragmentation was necessary. In both
src/openvpn/push.c +0 -2
@@ -582,8 +582,6 @@* @param tls_multi tls multi context of VPN tunnel * @param gc gc arena for allocating push options * @param push_list push list to where options are added -* -* @return true on success, false on failure. */ void prepare_auth_token_push_reply(struct tls_multi *tls_multi, struct gc_arena *gc,
[Openvpn-devel] [PATCH applied] Re: Fix new doxygen warnings about using @return in void functions
Not much for me to test - only doxygen comments are changed, and Arne/Antonio have reviewed these.
Your patch has been applied to the master branch.
commit c18a995d0e6752575299a750539acd5e35115846
Author: Frank Lichtenheld Date: Wed Jul 2 17:04:27 2025 +0200
Fix new doxygen warnings about using @return in void functions
Signed-off-by: Frank Lichtenheld <[email protected]...>
Acked-by: Antonio Quartulli <[email protected]...>
Message-Id: <[email protected]...>
URL: https://www.mail-archive.com/[email protected]/msg32027.html
Signed-off-by: Gert Doering <[email protected]...>--
kind regards,
Gert Doering
cron2 has uploaded a new patch set (#3) to the change originally created by flichtenheld. ( http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email )
The following approvals got outdated and were removed:
Code-Review+2 by ordex
Change subject: Fix new doxygen warnings about using @return in void functions
......................................................................
Fix new doxygen warnings about using @return in void functions
These seem to have been added in a more recent doxygen version than I previously tested with.
Message-Id: <[email protected]...>
URL: https://www.mail-archive.com/[email protected]/msg32027.html
---
M src/openvpn/crypto.h
M src/openvpn/fragment.h
M src/openvpn/push.c
3 files changed, 8 insertions(+), 8 deletions(-)
git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/29/1029/3
src/openvpn/crypto.h +2 -2
@@ -467,12 +467,12 @@* If an error occurs during processing, then the \a buf %buffer is set to * empty. * -* @param buf - The %buffer containing the packet on which to +* @param[in,out] buf - The %buffer containing the packet on which to * perform security operations. * @param work - An initialized working %buffer. * @param opt - The security parameter state for this VPN tunnel. * -* @return This function returns void.\n On return, the \a buf argument +* @note On return, the \a buf argument * will point to the resulting %buffer. This %buffer will either * contain the processed packet ready for sending, or be empty if an * error occurred.
src/openvpn/fragment.h +6 -4
@@ -309,7 +309,7 @@* * @param f - The \c fragment_master structure for this VPN * tunnel. -* @param buf - A pointer to the buffer structure containing the +* @param[in,out] buf - A pointer to the buffer structure containing the * incoming packet. This pointer will have been * modified on return either to point to a * completely reassembled packet, or to have length
@@ -317,7 +317,8 @@* @param frame - The packet geometry parameters for this VPN * tunnel. * -* @return Void.\n On return, the \a buf argument will point to a buffer. +* @note On return the \a buf argument buffer will be modified +* to communicate the result of the function. * The buffer will have nonzero length if the incoming packet passed * to this function was whole and unfragmented, or if it was the final * part of a fragmented packet thereby completing reassembly. On the
@@ -363,14 +364,15 @@* * @param f - The \c fragment_master structure for this VPN * tunnel. -* @param buf - A pointer to the buffer structure containing the +* @param[in,out] buf - A pointer to the buffer structure containing the * outgoing packet. This pointer will be modified * to point to a whole unfragmented packet or to the * first part of a fragmented packet on return. * @param frame - The packet geometry parameters for this VPN * tunnel. * -* @return Void.\n On return, the \a buf argument will point to a buffer. +* @note On return the \a buf argument buffer will be modified +* to communicate the result of the function. * This buffer contains either the whole original outgoing packet if * fragmentation was not necessary, or the first part of the * fragmented outgoing packet if fragmentation was necessary. In both
src/openvpn/push.c +0 -2
@@ -582,8 +582,6 @@* @param tls_multi tls multi context of VPN tunnel * @param gc gc arena for allocating push options * @param push_list push list to where options are added -* -* @return true on success, false on failure. */ void prepare_auth_token_push_reply(struct tls_multi *tls_multi, struct gc_arena *gc,
--
To view, visit http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email
To unsubscribe, or for help writing mail filters, visit http://gerrit.openvpn.net/settings
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Ia2b3eda18bd6dbce6c470037c7a01097e8147c29
Gerrit-Change-Number: 1029
Gerrit-PatchSet: 3
Gerrit-Owner: flichtenheld <[email protected]...>
Gerrit-Reviewer: ordex <[email protected]...>
Gerrit-Reviewer: plaisthos <[email protected]...>
Gerrit-CC: openvpn-devel <[email protected]>
Gerrit-MessageType: newpatchset
cron2 has submitted this change. ( http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email )
Change subject: Fix new doxygen warnings about using @return in void functions
......................................................................
Fix new doxygen warnings about using @return in void functions
These seem to have been added in a more recent doxygen version than I previously tested with.
Message-Id: <[email protected]...>
URL: https://www.mail-archive.com/[email protected]/msg32027.html
---
M src/openvpn/crypto.h
M src/openvpn/fragment.h
M src/openvpn/push.c
3 files changed, 8 insertions(+), 8 deletions(-)
src/openvpn/crypto.h +2 -2
@@ -467,12 +467,12 @@* If an error occurs during processing, then the \a buf %buffer is set to * empty. * -* @param buf - The %buffer containing the packet on which to +* @param[in,out] buf - The %buffer containing the packet on which to * perform security operations. * @param work - An initialized working %buffer. * @param opt - The security parameter state for this VPN tunnel. * -* @return This function returns void.\n On return, the \a buf argument +* @note On return, the \a buf argument * will point to the resulting %buffer. This %buffer will either * contain the processed packet ready for sending, or be empty if an * error occurred.
src/openvpn/fragment.h +6 -4
@@ -309,7 +309,7 @@* * @param f - The \c fragment_master structure for this VPN * tunnel. -* @param buf - A pointer to the buffer structure containing the +* @param[in,out] buf - A pointer to the buffer structure containing the * incoming packet. This pointer will have been * modified on return either to point to a * completely reassembled packet, or to have length
@@ -317,7 +317,8 @@* @param frame - The packet geometry parameters for this VPN * tunnel. * -* @return Void.\n On return, the \a buf argument will point to a buffer. +* @note On return the \a buf argument buffer will be modified +* to communicate the result of the function. * The buffer will have nonzero length if the incoming packet passed * to this function was whole and unfragmented, or if it was the final * part of a fragmented packet thereby completing reassembly. On the
@@ -363,14 +364,15 @@* * @param f - The \c fragment_master structure for this VPN * tunnel. -* @param buf - A pointer to the buffer structure containing the +* @param[in,out] buf - A pointer to the buffer structure containing the * outgoing packet. This pointer will be modified * to point to a whole unfragmented packet or to the * first part of a fragmented packet on return. * @param frame - The packet geometry parameters for this VPN * tunnel. * -* @return Void.\n On return, the \a buf argument will point to a buffer. +* @note On return the \a buf argument buffer will be modified +* to communicate the result of the function. * This buffer contains either the whole original outgoing packet if * fragmentation was not necessary, or the first part of the * fragmented outgoing packet if fragmentation was necessary. In both
src/openvpn/push.c +0 -2
@@ -582,8 +582,6 @@* @param tls_multi tls multi context of VPN tunnel * @param gc gc arena for allocating push options * @param push_list push list to where options are added -* -* @return true on success, false on failure. */ void prepare_auth_token_push_reply(struct tls_multi *tls_multi, struct gc_arena *gc,
--
To view, visit http://gerrit.openvpn.net/c/openvpn/+/1029?usp=email
To unsubscribe, or for help writing mail filters, visit http://gerrit.openvpn.net/settings
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: Ia2b3eda18bd6dbce6c470037c7a01097e8147c29
Gerrit-Change-Number: 1029
Gerrit-PatchSet: 3
Gerrit-Owner: flichtenheld <[email protected]...>
Gerrit-Reviewer: ordex <[email protected]...>
Gerrit-Reviewer: plaisthos <[email protected]...>
Gerrit-CC: openvpn-devel <[email protected]>
Gerrit-MessageType: merged